hips2fits: make Pillow an optional dependency with a clear ImportError - #3619
Open
kushasahu7 wants to merge 5 commits into
Open
hips2fits: make Pillow an optional dependency with a clear ImportError#3619kushasahu7 wants to merge 5 commits into
kushasahu7 wants to merge 5 commits into
Conversation
PIL was imported unconditionally at module level, causing a hard crash on `import astroquery.hips2fits` when Pillow is not installed, even though it is only needed for jpg/png response decoding. Moved the import inside _parse_result behind a try/except ImportError, and added Pillow to the `all` extras in pyproject.toml so it is properly declared as optional. Added unit tests that verify a helpful ImportError is raised for both jpg and png formats when Pillow is absent. Closes astropy#3556
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3619 +/- ##
==========================================
+ Coverage 73.17% 73.20% +0.03%
==========================================
Files 227 227
Lines 21078 21079 +1
==========================================
+ Hits 15423 15431 +8
+ Misses 5655 5648 -7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Author
|
@bsipocz When you have some time, can you review this PR ? |
bsipocz
reviewed
Jul 19, 2026
bsipocz
left a comment
bsipocz
left a comment
Member
There was a problem hiding this comment.
this needs some cleanup, but the big picture looks good.
thanks
| mock_response.status_code = 200 | ||
| mock_response.content = b'fake_image_bytes' | ||
|
|
||
| with patch.dict(sys.modules, {'PIL': None, 'PIL.Image': None}): |
Member
There was a problem hiding this comment.
I don't think this is the correct approach, use pytest markers instead to check for the missing pillow install.
| with pytest.raises(ImportError, match="Pillow is required"): | ||
| hips2fits._parse_result(mock_response, verbose=False, format='jpg') | ||
|
|
||
| def test_png_format_requires_pillow(self): |
Member
There was a problem hiding this comment.
These two tests are practically identical, please use pytest parametrize
Comment on lines
+109
to
+111
| - ``Pillow`` is now an optional dependency: importing ``astroquery.hips2fits`` no | ||
| longer crashes when Pillow is not installed. A clear ``ImportError`` is raised | ||
| only when a jpg/png response is actually decoded. [#3619] |
Member
There was a problem hiding this comment.
This needs a rewrite, pillow has been an optional dependency already.
Suggested change
| - ``Pillow`` is now an optional dependency: importing ``astroquery.hips2fits`` no | |
| longer crashes when Pillow is not installed. A clear ``ImportError`` is raised | |
| only when a jpg/png response is actually decoded. [#3619] | |
| - Fix the import error for not available optional dependency Pillow. A clear ``ImportError`` is raised | |
| only when a jpg/png response is actually decoded. [#3619] |
Author
|
Thanks for the review @bsipocz! Addressed all three:
|
The jpg/png branch of _parse_result had no offline test: the only unit tests covered the missing-Pillow error, which is skipped whenever Pillow is installed. Decode a small generated image to exercise the branch. The except ImportError guard cannot be reached when Pillow is present, so mark it no cover rather than leave it as a permanent coverage gap; it is still exercised by the skipif test in the mandatory-dependencies job.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes the remaining open item in #3556.
PILwas imported unconditionally at module level inhips2fits/core.py, causing a hardModuleNotFoundErroronimport astroquery.hips2fitswhen Pillow is not installed — even though it is only needed when decoding jpg/png responses.Changes
from PIL import Imageinside_parse_result()behind atry/except ImportErrorwith a helpful install messagePillowto thealloptional extras inpyproject.tomlRelated
boto3/botocorein MAST: Enable cloud dataset by default #3534